EUDI SD-JWT/eu.europa.ec.eudi.sdjwt.vc

Package-level declarations

Types

@Serializable

data class ClaimDisplay(val lang: LangTag, val label: String, val description: String? = null)

@Serializable

data class ClaimMetadata(val path: ClaimPath, val display: List<ClaimDisplay>? = null, val selectivelyDisclosable: ClaimSelectivelyDisclosable? = DefaultSelectivelyDisclosable, val svgId: SvgId? = null)

ClaimPath

@Serializable(with = ClaimPathSerializer::class)

@JvmInline

value class ClaimPath(val value: List<ClaimPathElement>)

The path is a non-empty list of elements, null values, or non-negative integers. It is used to select a particular claim in the credential or a set of claims.

ClaimPathElement

sealed interface ClaimPathElement

Elements of a ClaimPath

ClaimPathSerializer

object ClaimPathSerializer : KSerializer<ClaimPath>

Serializer for ClaimPath

ClaimSelectivelyDisclosable

@Serializable

enum ClaimSelectivelyDisclosable : Enum<ClaimSelectivelyDisclosable>

CssColor

@Serializable

@JvmInline

value class CssColor(val value: String)

An RGB color value as defined in W3C.CSS-COLOR

Display

@Serializable

@JvmInline

value class Display(val value: List<DisplayMetadata>)

DisplayMetadata

@Serializable

data class DisplayMetadata(val lang: LangTag, val name: String, val description: String? = null, val rendering: RenderingMetadata? = null)

DocumentIntegrity

@Serializable

@JvmInline

value class DocumentIntegrity(val value: String)

GetJwkSetKtorOps

interface GetJwkSetKtorOps

Gets the JWKSet given a location

GetSdJwtVcIssuerMetadataOps

interface GetSdJwtVcIssuerMetadataOps

Gets the metadata of an SD-JWT VC issuer.

JsonSchema

@Serializable

@JvmInline

value class JsonSchema(val value: JsonObject)

KtorHttpClientFactory

typealias KtorHttpClientFactory = () -> HttpClient

Alias of a method that creates a HttpClient

LangTag

@Serializable

@JvmInline

value class LangTag(val value: String)

LogoMetadata

@Serializable

data class LogoMetadata(val uri: URI, val uriIntegrity: DocumentIntegrity? = null, val altText: String? = null)

LookupPublicKeysFromDIDDocument

fun interface LookupPublicKeysFromDIDDocument

A function to look up public keys from DIDs/DID URLs.

RenderingMetadata

@Serializable

data class RenderingMetadata(val simple: SimpleRenderingMethod? = null, val svgTemplates: List<SvgTemplate>? = null)

SdJwtVcIssuerMetadata

@Serializable

data class SdJwtVcIssuerMetadata(val issuer: URI, val jwksUri: URI? = null, val jwks: JsonObject? = null)

SdJwtVcTypeMetadata

@Serializable

data class SdJwtVcTypeMetadata(val vct: Vct, val vctIntegrity: DocumentIntegrity? = null, val name: String? = null, val description: String? = null, val extends: URI? = null, val extendsIntegrity: DocumentIntegrity? = null, val display: Display? = null, val claims: List<ClaimMetadata>? = null, val schema: JsonSchema? = null, val schemaUri: URI? = null, val schemaUriIntegrity: DocumentIntegrity? = null)

SdJwtVcVerifier

interface SdJwtVcVerifier<out JWT>

An SD-JWT-VC specific verifier

SdJwtVcVerifierFactory

interface SdJwtVcVerifierFactory<out JWT>

SelectPath

fun interface SelectPath

Matches a ClaimPath to a JsonElement

SimpleRenderingMethod

@Serializable

data class SimpleRenderingMethod(val logo: LogoMetadata? = null, val backgroundColor: CssColor? = null, val textColor: CssColor? = null)

The simple rendering method is intended for use in applications that do not support SVG rendering

SvgColorScheme

@Serializable

enum SvgColorScheme : Enum<SvgColorScheme>

SvgContrast

@Serializable

enum SvgContrast : Enum<SvgContrast>

SvgId

@Serializable

@JvmInline

value class SvgId(val value: String)

It MUST consist of only alphanumeric characters and underscores and MUST NOT start with a digit

SvgOrientation

@Serializable

enum SvgOrientation : Enum<SvgOrientation>

SvgTemplate

@Serializable

data class SvgTemplate(val uri: URI, val uriIntegrity: DocumentIntegrity? = null, val properties: SvgTemplateProperties? = null)

SvgTemplateProperties

@Serializable

data class SvgTemplateProperties(val orientation: SvgOrientation? = null, val colorScheme: SvgColorScheme? = null, val contrast: SvgContrast? = null)

Properties for the SVG template

URISerializer

object URISerializer : KSerializer<URI>

Vct

@Serializable

@JvmInline

value class Vct(val value: String)

X509CertificateTrust

fun interface X509CertificateTrust

Properties

DefaultHttpClientFactory

val DefaultHttpClientFactory: KtorHttpClientFactory

Factory which produces a Ktor Http client

Functions

fold

inline fun <T> ClaimPathElement.fold(ifAllArrayElements: () -> T, ifArrayElement: (Int) -> T, ifClaim: (String) -> T): T

map

fun <JWT, JWT1> SdJwtVcVerifier<JWT>.map(f: (JWT) -> JWT1): SdJwtVcVerifier<JWT1>

sanOfDNSName

fun X509Certificate.sanOfDNSName(): Result<List<String>>

sanOfUniformResourceIdentifier

fun X509Certificate.sanOfUniformResourceIdentifier(): Result<List<String>>

sdJwtVcSignatureVerifier

fun sdJwtVcSignatureVerifier(httpClientFactory: KtorHttpClientFactory? = null, trust: X509CertificateTrust? = null, lookup: LookupPublicKeysFromDIDDocument? = null): JwtSignatureVerifier<SignedJWT>

Factory method for producing a SD-JWT-VC specific signature verifier. This verifier will get the Issuer's public key from the JWT part of the SD-JWT. In particular,